org.eclipse.vtp.framework.engine
Class ConfigurationDescriptor

java.lang.Object
  org.eclipse.vtp.framework.engine.ConfigurationDescriptor

public final class ConfigurationDescriptor
extends java.lang.Object

An object that describes an action configuration format.

Author:

Lonnie Pryor

Constructor Summary

ConfigurationDescriptor(java.lang.String id, java.lang.String name, java.lang.String xmlNamespace, java.lang.String xmlTag, java.lang.Class type)
Creates a new ConfigurationDescriptor.

Method Summary

java.lang.String	getId() Returns the ID of this configuration format.
java.lang.String	getName() Returns the name of this configuration format.
java.lang.Class	getType() Returns the type of this configuration format.
java.lang.String	getXmlNamespace() Returns the XML name space URI of the configuration format.
java.lang.String	getXmlTag() Returns the XML tag name of the configuration format.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ConfigurationDescriptor

public ConfigurationDescriptor(java.lang.String id,
                               java.lang.String name,
                               java.lang.String xmlNamespace,
                               java.lang.String xmlTag,
                               java.lang.Class type)
                        throws java.lang.IllegalArgumentException,
                               java.lang.NullPointerException

Creates a new ConfigurationDescriptor.

Parameters:

id - The ID of this configuration format.

name - The name of this configuration format.

xmlNamespace - The XML name space URI of the configuration format.

xmlTag - The XML tag name of the configuration format.

type - The type of this configuration format.

Throws:

java.lang.IllegalArgumentException - If the supplied ID is empty.

java.lang.IllegalArgumentException - If the supplied name is empty.

java.lang.IllegalArgumentException - If the supplied XML name space URI is empty.

java.lang.IllegalArgumentException - If the supplied XML tag name is empty.

java.lang.IllegalArgumentException - If the supplied type is not a public, concrete class with a public, no-argument constructor or is not assignable to IConfiguration.

java.lang.NullPointerException - If the supplied ID is null.

java.lang.NullPointerException - If the supplied name is null.

java.lang.NullPointerException - If the supplied XML name space URI is null.

java.lang.NullPointerException - If the supplied XML tag name is null.

java.lang.NullPointerException - If the supplied type is null.

Method Detail

getId

public java.lang.String getId()

Returns the ID of this configuration format.

Returns:

The ID of this configuration format.

getName

public java.lang.String getName()

Returns the name of this configuration format.

Returns:

The name of this configuration format.

getXmlNamespace

public java.lang.String getXmlNamespace()

Returns the XML name space URI of the configuration format.

Returns:

The XML name space URI of the configuration format.

getXmlTag

public java.lang.String getXmlTag()

Returns the XML tag name of the configuration format.

Returns:

The XML tag name of the configuration format.

getType

public java.lang.Class getType()

Returns the type of this configuration format.

Returns:

The type of this configuration format.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object